<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">

<title>class Bundler::Plugin::Index - bundler: Ruby Standard Library Documentation</title>


<script src="../../js/navigation.js" defer></script>
<script src="../../js/search.js" defer></script>
<script src="../../js/search_index.js" defer></script>
<script src="../../js/searcher.js" defer></script>
<script src="../../js/darkfish.js" defer></script>

<script src="../../js/jquery-3.2.0.min.js"></script>

<script src="../../js/vue.min.js"></script>
<script src="../../js/js.cookie.min.js"></script>

<link href="../../css/fonts.css" rel="stylesheet">
<link id='rdoccss' href="../../css/rdoc.css" rel="stylesheet">
<link href="../../css/carbon17.css" rel="stylesheet">

<script type="text/javascript">
  var rdoc_rel_prefix = "../../";
  var index_rel_prefix = "../../";
  var darkModeCsseHref = "../../css/rdoc-dm.css"
  var defaultModeCssHref = "../../css/rdoc.css"
  // var cssDarkmode = Cookies.get('darkmode');
  
  if( Cookies.get("darkmode") == "true") {
	$('#rdoccss').attr("href", darkModeCsseHref);
}

//  https://cssdeck.com/blog/simple-jquery-stylesheet-switcher/

document.write('<style type="text/css">body{display:none}</style>');

</script>


</head>
<body id="top" role="document" class="class">
  <!-- this is class.html -->

  <div id='actionbar' >
    <div class='wrapper mdiv'>
      <ul class='grids g0'></ul>
    </div> 
    <!-- VERSION HEADER for 3.3.0.preview2 NOT FOUND -->
  </div> <!-- end action bar -->

  <div class='wrapper hdiv'>

    


    <nav id='vapp' role="navigation">
    <div id="project-navigation">
      <div id="home-section" role="region" title="Quick navigation" class="nav-section">
  <h2><a href="../../index.html" rel="home">Home</a></h2>

  <div id="table-of-contents-navigation"  >
    <a href="../../table_of_contents.html#pages">Pages</a>
    <a href="../../table_of_contents.html#classes">Classes</a>
    <a href="../../table_of_contents.html#methods">Methods</a>
  </div>
</div>

      <div id="search-section" role="search" class="project-section initially-hidden">
  <form action="#" method="get" accept-charset="utf-8">
    <div id="search-field-wrapper">
      <input id="search-field" role="combobox" aria-label="Search"
             aria-autocomplete="list" aria-controls="search-results"
             type="text" name="search" placeholder="Search" spellcheck="false"
             title="Type to search, Up and Down to navigate, Enter to load">
    </div>

    <ul id="search-results" aria-label="Search Results"
        aria-busy="false" aria-expanded="false"
        aria-atomic="false" class="initially-hidden"></ul>
  </form>
</div>

    </div>


    

    <button id='toggleThing' @click="toggleNav()" >Show/hide navigation</button>
    <div :class="isOpen ? 'block' : 'hidden' " id='toggleMe'>
      <div id="class-metadata">
        
        
<div id="parent-class-section" class="nav-section">
  <h3>Parent</h3>

  <p class="link"><a href="../../Object.html">Object</a>
</div>

        
        
        
<!-- Method Quickref -->
<div id="method-list-section" class="nav-section">
  <h3>Methods</h3>

  <ul class="link-list" role="directory">
    <li ><a href="#method-c-new">::new</a>
    <li ><a href="#method-i-command_plugin">#command_plugin</a>
    <li ><a href="#method-i-global_index_file">#global_index_file</a>
    <li ><a href="#method-i-hook_plugins">#hook_plugins</a>
    <li ><a href="#method-i-index_file">#index_file</a>
    <li ><a href="#method-i-installed-3F">#installed?</a>
    <li ><a href="#method-i-installed_plugins">#installed_plugins</a>
    <li ><a href="#method-i-load_index">#load_index</a>
    <li ><a href="#method-i-load_paths">#load_paths</a>
    <li ><a href="#method-i-local_index_file">#local_index_file</a>
    <li ><a href="#method-i-plugin_commands">#plugin_commands</a>
    <li ><a href="#method-i-plugin_path">#plugin_path</a>
    <li ><a href="#method-i-register_plugin">#register_plugin</a>
    <li ><a href="#method-i-save_index">#save_index</a>
    <li ><a href="#method-i-source-3F">#source?</a>
    <li ><a href="#method-i-source_plugin">#source_plugin</a>
    <li ><a href="#method-i-unregister_plugin">#unregister_plugin</a>
  </ul>
</div>

      </div>
     </div>
    </nav>


    <div id='extraz'><div class='adzbox-index'  >
      
     </div>         
    </div>

    <main role="main" aria-labelledby="class-Bundler::Plugin::Index">
    <h1 id="class-Bundler::Plugin::Index" class="class">
      class Bundler::Plugin::Index
    </h1>

    <section class="description">
    
    </section>

      <section id="5Buntitled-5D" class="documentation-section">



        <section class="attribute-method-details" class="method-section">
        <header>
        <h3>Attributes</h3>
        </header>

          <div id="attribute-i-commands" class="method-detail">
            <div class="method-heading attribute-method-heading">
              <span class="method-name">commands</span><span
                class="attribute-access-type">[R]</span>
            </div>

            <div class="method-description">
              
              </div>
            </div>
            </section>


                <section id="public-class-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Class Methods</h3>
                </header>

                  <div id="method-c-new" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">new</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="new-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 25</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">initialize</span>
  <span class="ruby-ivar">@plugin_paths</span> = {}
  <span class="ruby-ivar">@commands</span> = {}
  <span class="ruby-ivar">@sources</span> = {}
  <span class="ruby-ivar">@hooks</span> = {}
  <span class="ruby-ivar">@load_paths</span> = {}

  <span class="ruby-keyword">begin</span>
    <span class="ruby-identifier">load_index</span>(<span class="ruby-identifier">global_index_file</span>, <span class="ruby-keyword">true</span>)
  <span class="ruby-keyword">rescue</span> <span class="ruby-constant">GenericSystemCallError</span>
    <span class="ruby-comment"># no need to fail when on a read-only FS, for example</span>
    <span class="ruby-keyword">nil</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-identifier">load_index</span>(<span class="ruby-identifier">local_index_file</span>) <span class="ruby-keyword">if</span> <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">in_bundle?</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

                <section id="public-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Public Instance Methods</h3>
                </header>

                  <div id="method-i-command_plugin" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">command_plugin</span><span
                                class="method-args">(command)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Fetch the name of plugin handling the command</p>

                              <div class="method-source-code" id="command_plugin-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 110</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">command_plugin</span>(<span class="ruby-identifier">command</span>)
  <span class="ruby-ivar">@commands</span>[<span class="ruby-identifier">command</span>]
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-global_index_file" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">global_index_file</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Path where the global index file is stored</p>

                              <div class="method-source-code" id="global_index_file-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 92</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">global_index_file</span>
  <span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">global_root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;index&quot;</span>)
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-hook_plugins" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">hook_plugins</span><span
                                class="method-args">(event)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Returns the list of plugin names handling the passed event</p>

                              <div class="method-source-code" id="hook_plugins-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 135</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">hook_plugins</span>(<span class="ruby-identifier">event</span>)
  <span class="ruby-ivar">@hooks</span>[<span class="ruby-identifier">event</span>] <span class="ruby-operator">||</span> []
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-index_file" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">index_file</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Path of default index file</p>

                              <div class="method-source-code" id="index_file-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 87</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">index_file</span>
  <span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;index&quot;</span>)
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-installed-3F" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">installed?</span><span
                                class="method-args">(name)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="installed-3F-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 114</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">installed?</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-ivar">@plugin_paths</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-installed_plugins" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">installed_plugins</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="installed_plugins-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 118</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">installed_plugins</span>
  <span class="ruby-ivar">@plugin_paths</span>.<span class="ruby-identifier">keys</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-load_paths" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">load_paths</span><span
                                class="method-args">(name)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="load_paths-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 105</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_paths</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-ivar">@load_paths</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-local_index_file" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">local_index_file</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Path where the local index file is stored</p>

                              <div class="method-source-code" id="local_index_file-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 97</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">local_index_file</span>
  <span class="ruby-constant">Plugin</span>.<span class="ruby-identifier">local_root</span>.<span class="ruby-identifier">join</span>(<span class="ruby-string">&quot;index&quot;</span>)
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-plugin_commands" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">plugin_commands</span><span
                                class="method-args">(plugin)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="plugin_commands-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 122</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">plugin_commands</span>(<span class="ruby-identifier">plugin</span>)
  <span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">find_all</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">_</span>, <span class="ruby-identifier">n</span><span class="ruby-operator">|</span> <span class="ruby-identifier">n</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">plugin</span> }.<span class="ruby-identifier">map</span>(<span class="ruby-operator">&amp;</span><span class="ruby-value">:first</span>)
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-plugin_path" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">plugin_path</span><span
                                class="method-args">(name)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="plugin_path-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 101</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">plugin_path</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-constant">Pathname</span>.<span class="ruby-identifier">new</span> <span class="ruby-ivar">@plugin_paths</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-register_plugin" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">register_plugin</span><span
                                class="method-args">(name, path, load_paths, commands, sources, hooks)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>This function is to be called when a new plugin is installed. This function shall add the functions of the plugin to existing maps and also the name to source location.</p>

<p>@param [String] name of the plugin to be registered @param [String] path where the plugin is installed @param [Array&lt;String&gt;] <a href="Index.html#method-i-load_paths"><code>load_paths</code></a> for the plugin @param [Array&lt;String&gt;] commands that are handled by the plugin @param [Array&lt;String&gt;] sources that are handled by the plugin</p>

                              <div class="method-source-code" id="register_plugin-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 50</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">register_plugin</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">path</span>, <span class="ruby-identifier">load_paths</span>, <span class="ruby-identifier">commands</span>, <span class="ruby-identifier">sources</span>, <span class="ruby-identifier">hooks</span>)
  <span class="ruby-identifier">old_commands</span> = <span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">dup</span>

  <span class="ruby-identifier">common</span> = <span class="ruby-identifier">commands</span> <span class="ruby-operator">&amp;</span> <span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">keys</span>
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">CommandConflict</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">common</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">common</span>.<span class="ruby-identifier">empty?</span>
  <span class="ruby-identifier">commands</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">c</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@commands</span>[<span class="ruby-identifier">c</span>] = <span class="ruby-identifier">name</span> }

  <span class="ruby-identifier">common</span> = <span class="ruby-identifier">sources</span> <span class="ruby-operator">&amp;</span> <span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">keys</span>
  <span class="ruby-identifier">raise</span> <span class="ruby-constant">SourceConflict</span>.<span class="ruby-identifier">new</span>(<span class="ruby-identifier">name</span>, <span class="ruby-identifier">common</span>) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">common</span>.<span class="ruby-identifier">empty?</span>
  <span class="ruby-identifier">sources</span>.<span class="ruby-identifier">each</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">k</span><span class="ruby-operator">|</span> <span class="ruby-ivar">@sources</span>[<span class="ruby-identifier">k</span>] = <span class="ruby-identifier">name</span> }

  <span class="ruby-identifier">hooks</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">event</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">event_hooks</span> = (<span class="ruby-ivar">@hooks</span>[<span class="ruby-identifier">event</span>] <span class="ruby-operator">||=</span> []) <span class="ruby-operator">&lt;&lt;</span> <span class="ruby-identifier">name</span>
    <span class="ruby-identifier">event_hooks</span>.<span class="ruby-identifier">uniq!</span>
  <span class="ruby-keyword">end</span>

  <span class="ruby-ivar">@plugin_paths</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">path</span>
  <span class="ruby-ivar">@load_paths</span>[<span class="ruby-identifier">name</span>] = <span class="ruby-identifier">load_paths</span>
  <span class="ruby-identifier">save_index</span>
<span class="ruby-keyword">rescue</span> <span class="ruby-constant">StandardError</span>
  <span class="ruby-ivar">@commands</span> = <span class="ruby-identifier">old_commands</span>
  <span class="ruby-identifier">raise</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-source-3F" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">source?</span><span
                                class="method-args">(source)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="source-3F-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 126</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">source?</span>(<span class="ruby-identifier">source</span>)
  <span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">key?</span> <span class="ruby-identifier">source</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-source_plugin" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">source_plugin</span><span
                                class="method-args">(name)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="source_plugin-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 130</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">source_plugin</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-ivar">@sources</span>[<span class="ruby-identifier">name</span>]
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-unregister_plugin" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">unregister_plugin</span><span
                                class="method-args">(name)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              

                              <div class="method-source-code" id="unregister_plugin-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 74</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">unregister_plugin</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">delete_if</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">_</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span> }
  <span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">delete_if</span> {<span class="ruby-operator">|</span><span class="ruby-identifier">_</span>, <span class="ruby-identifier">v</span><span class="ruby-operator">|</span> <span class="ruby-identifier">v</span> <span class="ruby-operator">==</span> <span class="ruby-identifier">name</span> }
  <span class="ruby-ivar">@hooks</span>.<span class="ruby-identifier">each</span> <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">hook</span>, <span class="ruby-identifier">names</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">names</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">name</span>)
    <span class="ruby-ivar">@hooks</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">hook</span>) <span class="ruby-keyword">if</span> <span class="ruby-identifier">names</span>.<span class="ruby-identifier">empty?</span>
  <span class="ruby-keyword">end</span>
  <span class="ruby-ivar">@plugin_paths</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-ivar">@load_paths</span>.<span class="ruby-identifier">delete</span>(<span class="ruby-identifier">name</span>)
  <span class="ruby-identifier">save_index</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

                <section id="private-instance-5Buntitled-5D-method-details" class="method-section">
                <header>
                <h3>Private Instance Methods</h3>
                </header>

                  <div id="method-i-load_index" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">load_index</span><span
                                class="method-args">(index_file, global = false)</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Reads the index file from the directory and initializes the instance variables.</p>

<p>It skips the sources if the second param is true @param [Pathname] index file path @param [Boolean] is the index file global index</p>

                              <div class="method-source-code" id="load_index-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 147</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">load_index</span>(<span class="ruby-identifier">index_file</span>, <span class="ruby-identifier">global</span> = <span class="ruby-keyword">false</span>)
  <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">index_file</span>, <span class="ruby-value">:read</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">index_f</span><span class="ruby-operator">|</span>
    <span class="ruby-identifier">valid_file</span> = <span class="ruby-identifier">index_f</span>&amp;.<span class="ruby-identifier">exist?</span> <span class="ruby-operator">&amp;&amp;</span> <span class="ruby-operator">!</span><span class="ruby-identifier">index_f</span>.<span class="ruby-identifier">size</span>.<span class="ruby-identifier">zero?</span>
    <span class="ruby-keyword">break</span> <span class="ruby-keyword">unless</span> <span class="ruby-identifier">valid_file</span>

    <span class="ruby-identifier">data</span> = <span class="ruby-identifier">index_f</span>.<span class="ruby-identifier">read</span>

    <span class="ruby-identifier">require_relative</span> <span class="ruby-string">&quot;../yaml_serializer&quot;</span>
    <span class="ruby-identifier">index</span> = <span class="ruby-constant">YAMLSerializer</span>.<span class="ruby-identifier">load</span>(<span class="ruby-identifier">data</span>)

    <span class="ruby-ivar">@commands</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">&quot;commands&quot;</span>])
    <span class="ruby-ivar">@hooks</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">&quot;hooks&quot;</span>])
    <span class="ruby-ivar">@load_paths</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">&quot;load_paths&quot;</span>])
    <span class="ruby-ivar">@plugin_paths</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">&quot;plugin_paths&quot;</span>])
    <span class="ruby-ivar">@sources</span>.<span class="ruby-identifier">merge!</span>(<span class="ruby-identifier">index</span>[<span class="ruby-string">&quot;sources&quot;</span>]) <span class="ruby-keyword">unless</span> <span class="ruby-identifier">global</span>
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                  <div id="method-i-save_index" class="method-detail ">
                            <div class="method-heading">
                              <span class="method-name">save_index</span><span
                                class="method-args">()</span>
                              <span class="method-click-advice">click to toggle source</span>
                            </div>

                            <div class="method-description">
                              <p>Should be called when any of the instance variables change. Stores the instance variables in YAML format. (The instance variables are supposed to be only String key value pairs)</p>

                              <div class="method-source-code" id="save_index-source">
            <pre><span class="ruby-comment"># File bundler/plugin/index.rb, line 168</span>
<span class="ruby-keyword">def</span> <span class="ruby-identifier ruby-title">save_index</span>
  <span class="ruby-identifier">index</span> = {
    <span class="ruby-string">&quot;commands&quot;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-ivar">@commands</span>,
    <span class="ruby-string">&quot;hooks&quot;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-ivar">@hooks</span>,
    <span class="ruby-string">&quot;load_paths&quot;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-ivar">@load_paths</span>,
    <span class="ruby-string">&quot;plugin_paths&quot;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-ivar">@plugin_paths</span>,
    <span class="ruby-string">&quot;sources&quot;</span> <span class="ruby-operator">=&gt;</span> <span class="ruby-ivar">@sources</span>,
  }

  <span class="ruby-identifier">require_relative</span> <span class="ruby-string">&quot;../yaml_serializer&quot;</span>
  <span class="ruby-constant">SharedHelpers</span>.<span class="ruby-identifier">filesystem_access</span>(<span class="ruby-identifier">index_file</span>) <span class="ruby-keyword">do</span> <span class="ruby-operator">|</span><span class="ruby-identifier">index_f</span><span class="ruby-operator">|</span>
    <span class="ruby-constant">FileUtils</span>.<span class="ruby-identifier">mkdir_p</span>(<span class="ruby-identifier">index_f</span>.<span class="ruby-identifier">dirname</span>)
    <span class="ruby-constant">File</span>.<span class="ruby-identifier">open</span>(<span class="ruby-identifier">index_f</span>, <span class="ruby-string">&quot;w&quot;</span>) {<span class="ruby-operator">|</span><span class="ruby-identifier">f</span><span class="ruby-operator">|</span> <span class="ruby-identifier">f</span>.<span class="ruby-identifier">puts</span> <span class="ruby-constant">YAMLSerializer</span>.<span class="ruby-identifier">dump</span>(<span class="ruby-identifier">index</span>) }
  <span class="ruby-keyword">end</span>
<span class="ruby-keyword">end</span></pre>
                              </div>
                            </div>


                          </div>

                          </section>

              </section>
              </main>



            </div>  <!--  class='wrapper hdiv' -->


<footer id="validator-badges" role="contentinfo">
<p><a href="https://validator.w3.org/check/referer">Validate</a></p>
<p>Generated by <a href="https://ruby.github.io/rdoc/">RDoc</a> 6.4.0.</p>
<p>Based on <a href="https://github.com/ged/darkfish/">Darkfish</a> by <a href="http://deveiate.org">Michael Granger</a>.</p>

  
    <p><p><a href="https://ruby-doc.org">Ruby-doc.org</a> is a service of <a href="https://jamesbritt.com">James Britt</a> and <a href="https://neurogami.com">Neurogami</a>, purveyors of fine <a href='https://jamesbritt.bandcamp.com/'>dance noise</a></p>
</p>
  
  </footer>

<script type="text/javascript">


  let ads  = $("#carbonads-container").children().detach();


  function swapMode() {
    var cookieName = 'darkmode';
    var cssDarkmode = Cookies.get(cookieName);
    console.log("***** swapMode! " + cssDarkmode + " *****");


    if (cssDarkmode == "true") {
      console.log("We have dark mode, set the css to light ...");
      $('#rdoccss').attr("href", defaultModeCssHref);
      $('#cssSelect').text("Dark mode");
      cssDarkmode = "false";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    } else {
      console.log("We not have dark mode, set the css to dark ...");
      $('#rdoccss').attr("href", darkModeCsseHref);
      $('#cssSelect').text("Light mode");
      cssDarkmode = "true";
      console.log("swapMode! Now set cookie to " + cssDarkmode);
      Cookies.set(cookieName, cssDarkmode);

    }

    console.log("  --------------- ");
  }


const vueCssApp = new Vue({
el: '#menubar',
data: {
isDark: false
},
methods: {
toggleClass: function(event){
this.isDark = !this.isDark;
}
}
})

const vueApp = new Vue({
el: '#vapp',
data: { 
isOpen: true
},

mounted() {
this.handleResize();
this.manage_mob_classes();
window.addEventListener('resize', this.handleResize)
//this.isOpen !=  (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},
destroyed() {
window.removeEventListener('resize', this.handleResize)
},
created() {
//manage_mob_classes();
},

methods : {
isMobile() {
  return (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent));
},

  handleResize() {
    if (!this.isMobile()) {
      this.isOpen = window.innerWidth > 800;
    }
  },

  manage_mob_classes() {
    if (/Android|webOS|iPhone|iPad|iPod|BlackBerry|IEMobile|Opera Mini/i.test(navigator.userAgent)) {
      $("nav").addClass("mob_nav");
      $("main").addClass("mob_main");
      $("#extraz").addClass("mob_extraz");
      $("#carbonads-container").addClass("mob_carbonads-container");
      this.isOpen  = false;
    } else {
      $("nav").removeClass("mob_nav") 
        $("main").removeClass("mob_main");
      $("#extraz").removeClass("mob_extraz");
      $("#carbonads-container").removeClass("mob_carbonads-container");
      this.isOpen  = true;
    }
  },

  toggleNav() {
    this.isOpen =! this.isOpen ;
    // alert("Toggle nav!");
    console.log("toggleNav() click: " + this.isOpen );
  }
}
})

$("#carbonads-container").append(ads);


$(function() {

    var darkmode = Cookies.get("darkmode");
    console.log("Document ready: " + darkmode);

    if ( darkmode  == "true" ) {
      $('#cssSelect').text("Light mode");
    } else {
      $('#cssSelect').text("Dark mode");
     }

    $('body').css('display','block');
    });

</script>

    
  </body> 
</html>

